Next Design extension development manual

Next Design Extension Development Manual
1. Overview of Extension
1. Overview of Extension
2. Development Guide
2. Development Guide
- Overview
- Development in script
  Development in script
- Development in DLL
  Development in DLL
- Common
  Common
3. Manifest Guide
3. Manifest Guide
- Overview
- Manifest structure
- Extension definition
- Extension point definition
  Extension point definition
  - Overview
  - Ribbon
  - Command
  - Event
- Predefined ID
4. Extension API Guide
4. Extension API Guide
- Overview
- Global
  Global
  - Overview
  - Global object
- Command
  Command
  - Overview
  - System command
- Event
  Event
  - Overview
  - Event Area
    Event Area
    
    Application
    Application
    
    Overview
    
    onAfterStart
    
    onBeforeQuit
    
    project
    project
    
    Overview
    
    onAfterNew
    
    onBeforeOpen
    
    onAfterOpen
    
    onBeforeSave onBeforeSave
    Table of contents
    
    Description
    
    API event argument type
    
    onAfterSave
    
    onBeforeClose
    
    onAfterClose
    
    onBeforeReload
    
    onAfterReload
    
    models
    models
    
    Overview
    
    onBeforeNew
    
    onAfterNew
    
    onFieldChanged
    
    onBeforeDelete
    
    onBeforeChangeOwner
    
    onAfterChangeOwner
    
    onBeforeChangeOrder
    
    onAfterChangeOrder
    
    onBeforeNewRelation
    
    onAfterNewRelation
    
    onValidate
    
    onError
    
    onModelEdited
    
    onUndoRedo
    
    commands
    commands
    
    Overview
    
    onBeforeExecute
    
    onAfterExecute
    
    editors
    editors
    
    Overview
    
    onShow
    
    onHide
    
    onSelectionChanged
    
    pages
    pages
    
    Overview
    
    onBeforeChange
    
    onAfterChange
    
    navigators
    navigators
    
    Overview
    
    onShow
    
    onHide
    
    onSelectionChanged
    
    informations
    informations
    
    Overview
    
    onShow
    
    onHide
    
    onSelectionChanged
    
    onDoubleClick
- Workspace Project
  Workspace Project
  - Overview
- Profile
  Profile
  - Overview
- Model
  Model
  - Overview
- User Interface
  User Interface
  - Overview
- Search Error Output
  Search Error Output
  - Overview
5. Tutorial
5. Tutorial
6. Download
6. Download
7. API List
7. API List
- Overview
- AfterExecuteEventParams
  AfterExecuteEventParams
  - Overview
  - Properties
    Properties
    
    Command
    
    Parameters
- AfterStartEventParams
  AfterStartEventParams
  - Overview
- BeforeExecuteEventParams
  BeforeExecuteEventParams
  - Overview
  - Properties
    Properties
    
    Command
    
    Parameters
- BeforeQuitEventParams
  BeforeQuitEventParams
  - Overview
- CancelableEventParams
  CancelableEventParams
  - Overview
  - Methods
    Methods
    
    Cancel
  - Properties
    Properties
    
    Canceled
- ConsumableEventParams
  ConsumableEventParams
  - Overview
  - Methods
    Methods
    
    Consume
  - Properties
    Properties
    
    IsConsume
- EditorOnHideEventParams
  EditorOnHideEventParams
  - Overview
- EditorOnShowEventParams
  EditorOnShowEventParams
  - Overview
- EditorSelectionChangedEventParams
  EditorSelectionChangedEventParams
  - Overview
- EventParams
  EventParams
  - Overview
- IApplication
  IApplication
  - Overview
  - Methods
    Methods
    
    CreateCommandParams
    
    CreateSearch
    
    ExecuteCommand
    
    Quit
    
    ThrowUserException
  - Properties
    Properties
    
    Env
    
    Errors
    
    Output
    
    Search
    
    Window
    
    Workspace
- IClass
  IClass
  - Overview
- ICommand
  ICommand
  - Overview
  - Properties
    Properties
    
    CanExecFunc
    
    Description
    
    ExecFunc
    
    Id
    
    Title
- ICommandContext
  ICommandContext
  - Overview
  - Properties
    Properties
    
    Command
    
    Global
    
    SenderModel
- ICommandParams
  ICommandParams
  - Overview
  - Methods
    Methods
    
    AddParam
    
    AddParamWithName
    
    GetByIndex
    
    GetByName
    
    ToArray
    
    ToCollection
  - Properties
    Properties
    
    Item [int]
    
    Item [string]
- ICommonUI
  ICommonUI
  - Overview
  - Methods
    Methods
    
    MessageBox
    
    ShowConfirmDialog
    
    ShowInformationDialog
    
    ShowMessageBox
    
    ShowOpenFileDialog
    
    ShowSaveFileDialog
    
    ShowSelectFolderDialog
- IContext
  IContext
  - Overview
  - Methods
    Methods
    
    GetProperty
    
    GetResourceString
    
    GetResourceString1
    
    GetResourceString2
    
    GetResourceString3
    
    HasProperty
    
    RemoveProperty
    
    SetProperty
  - Properties
    Properties
    
    App
    
    Application
- IEditorDef
  IEditorDef
  - Overview
  - Properties
    Properties
    
    Type
- IEditorEventParams
  IEditorEventParams
  - Overview
  - Properties
    Properties
    
    TargetEditorName
- IEditorPage
  IEditorPage
  - Overview
  - Methods
    Methods
    
    SetSubEditorMode (string, IModel)
    
    SetSubEditorMode (SubEditorMode, IModel)
  - Properties
    Properties
    
    ActiveInfoWindow
    
    ActiveNavigator
    
    ActivePalette
    
    CurrentEditorView
    
    CurrentInfoView
    
    CurrentModel
    
    CurrentNavigator
    
    CurrentOutputCategory
    
    IsErrorCardVisible
    
    IsFeatureMarkVisible
    
    IsIndicatorVisible
    
    IsInformationPaneVisible
    
    IsInspectorPaneVisible
    
    IsNavigatorPaneVisible
    
    IsSubEditorVisible
    
    IsTraceLineVisible
    
    MainEditorView
    
    SubEditorMode
    
    SubEditorView
- IEditorView
  IEditorView
  - Overview
  - Methods
    Methods
    
    SelectViewDefinition
  - Properties
    Properties
    
    SelectedModels
    
    ViewDefinitions
- IEnv
  IEnv
  - Overview
  - Properties
    Properties
    
    AppName
    
    Language
    
    Locale
    
    MachineId
    
    Path
    
    ProcessId
    
    Version
- IError
  IError
  - Overview
- IErrors
  IErrors
  - Overview
  - Methods
    Methods
    
    ClearErrors
    
    ClearErrorsAt
    
    FindErrorByCategory
    
    FindErrorOfModelByCategory
  - Properties
    Properties
    
    AllErrors
    
    Errors
    
    Informations
    
    Summaries
    
    Warnings
- IEvent
  IEvent
  - Overview
  - Properties
    Properties
    
    Area
    
    EventName
    
    FuncName
- IEventContext
  IEventContext
  - Overview
  - Properties
    Properties
    
    Event
- IEventParams
  IEventParams
  - Overview
- IExtension
  IExtension
  - Overview
  - Methods
    Methods
    
    Activate
    
    Deactivate
- IField
  IField
  - Overview
- IInfoDisplayStyle
  IInfoDisplayStyle
  - Overview
  - Methods
    Methods
    
    SetStyleSets
  - Properties
    Properties
    
    CardDisplayStyle
    
    Name
- IInfoDisplayStyleSet
  IInfoDisplayStyleSet
  - Overview
  - Methods
    Methods
    
    ClearAllStyles
    
    ClearStyle
    
    CreateStyle
    
    GetStyle
  - Properties
    Properties
    
    Styles
- IInfoEntry
  IInfoEntry
  - Overview
  - Properties
    Properties
    
    Category
    
    Code
    
    DetailMessage
    
    DisplayStyleName
    
    Fields
    
    Index
    
    Message
    
    Model
    
    NavigatingViewName
    
    Title
    
    Type
- IInfoView
  IInfoView
  - Overview
  - Methods
    Methods
    
    Select
  - Properties
    Properties
    
    IsVisible
    
    Items
    
    Name
    
    SelectedItems
    
    Title
- IModel
  IModel
- IModelDictionary
  IModelDictionary
  - Overview
  - Methods
    Methods
    
    Contains
    
    ContainsById
    
    GetByClass
    
    GetByClasses
    
    ToList
- INamedElement
  INamedElement
  - Overview
  - Properties
    Properties
    
    Name
- INavigator
  INavigator
  - Overview
  - Methods
    Methods
    
    Select
  - Properties
    Properties
    
    BaseType
    
    IsValid
    
    IsVisible
    
    Items
    
    MultiSelection
    
    Name
    
    SelectedItems
    
    Title
- InformationOnDoubleClickEventParams
  InformationOnDoubleClickEventParams
  - Overview
  - Properties
    Properties
    
    Entry
    
    InfoView
    
    Item
    
    Model
    
    Name
- InformationOnHideEventParams
  InformationOnHideEventParams
  - Overview
  - Properties
    Properties
    
    Name
- InformationOnShowEventParams
  InformationOnShowEventParams
  - Overview
  - Properties
    Properties
    
    Name
- InformationSelectionChangedEventParams
  InformationSelectionChangedEventParams
  - Overview
  - Properties
    Properties
    
    Name
- IObject
  IObject
  - Overview
  - Properties
    Properties
    
    Id
- IOutput
  IOutput
  - Overview
  - Methods
    Methods
    
    Clear
    
    ClearAll
    
    WriteFormatLine
    
    WriteLine
- IProfile
  IProfile
  - Overview
  - Properties
    Properties
    
    Name
    
    Path
    
    ViewDefinitions
- IProject
  IProject
  - Overview
  - Methods
    Methods
    
    AddNewRootModel
    
    GetModelById
    
    GetModelByPath
    
    GetRelationshipById
  - Properties
    Properties
    
    IsDirty
    
    Path
    
    Profile
- IRelationship
  IRelationship
  - Overview
  - Methods
    Methods
    
    Relate
    
    UnRelate
  - Properties
    Properties
    
    Source
    
    SourceIndex
    
    Target
    
    TargetIndex
- ISearch
  ISearch
  - Overview
  - Methods
    Methods
    
    AddSearchResult (IModel, string, string)
    
    AddSearchResult (object, string)
    
    AddSearchTarget
    
    BeginSearch
    
    CancelSearch
    
    ClearSearchResult
    
    ClearSearchTarget
    
    EndSearch
  - Properties
    Properties
    
    IsSearchCanceled
    
    IsSearching
    
    Name
    
    SearchTargets
    
    ShowTotalCount
    
    Type
- ISearchManager
  ISearchManager
  - Overview
  - Methods
    Methods
    
    ClearResults
    
    Create
    
    FindResultByModel
  - Properties
    Properties
    
    AllResults
- ISearchResultEntry
  ISearchResultEntry
  - Overview
  - Properties
    Properties
    
    Item
- IUIElement
  IUIElement
  - Overview
- IViewDefinition
  IViewDefinition
  - Overview
  - Properties
    Properties
    
    ModelClass
    
    ModelClassName
- IViewDefinitions
  IViewDefinitions
  - Overview
  - Methods
    Methods
    
    FindEditorDefByClass
  - Properties
    Properties
    
    Editors
- IWorkspace
  IWorkspace
  - Overview
  - Methods
    Methods
    
    CleanUpProject
    
    CloseProject
    
    CreateSearch
    
    NewProject
    
    OpenProject
    
    SaveProject
    
    SaveProjectAs
  - Properties
    Properties
    
    CurrentModel
    
    CurrentProject
    
    Errors
    
    InfoDisplayStyleSet
    
    Output
    
    Search
- IWorkspaceWindow
  IWorkspaceWindow
  - Overview
  - Properties
    Properties
    
    ActiveInfoWindow
    
    ActivePage
    
    CurrentInfoView
    
    CurrentOutputCategory
    
    EditorPage
    
    IsInformationPaneVisible
- ModelAfterChangeOrderEventParams
  ModelAfterChangeOrderEventParams
  - Overview
  - Properties
    Properties
    
    Field
    
    Model
    
    NewIndex
- ModelAfterChangeOwnerEventParams
  ModelAfterChangeOwnerEventParams
  - Overview
  - Properties
    Properties
    
    Field
    
    Model
    
    NewIndex
    
    NewOwner
- ModelAfterNewEventParams
  ModelAfterNewEventParams
  - Overview
  - Properties
    Properties
    
    Field
    
    NewModel
    
    Owner
- ModelAfterNewRelationEventParams
  ModelAfterNewRelationEventParams
  - Overview
  - Properties
    Properties
    
    Field
    
    Index
    
    Model
    
    OppositeField
    
    OppositeIndex
    
    RelatingTo
- ModelBeforeChangeOrderEventParams
  ModelBeforeChangeOrderEventParams
  - Overview
  - Properties
    Properties
    
    Field
    
    Model
    
    NewIndex
    
    OldIndex
- ModelBeforeChangeOwnerEventParams
  ModelBeforeChangeOwnerEventParams
  - Overview
  - Properties
    Properties
    
    Field
    
    Model
    
    NewIndex
    
    NewOwner
- ModelBeforeDeleteEventParams
  ModelBeforeDeleteEventParams
  - Overview
  - Properties
    Properties
    
    Model
- ModelBeforeNewEventParams
  ModelBeforeNewEventParams
  - Overview
  - Properties
    Properties
    
    ClassName
    
    Field
    
    Index
    
    Owner
- ModelBeforeNewRelationEventParams
  ModelBeforeNewRelationEventParams
  - Overview
  - Properties
    Properties
    
    Field
    
    Index
    
    Model
    
    OppositeField
    
    OppositeIndex
    
    RelatingTo
- ModelEditedEventParams
  ModelEditedEventParams
  - Overview
  - Properties
    Properties
    
    Models
- ModelFieldChangedEventParams
  ModelFieldChangedEventParams
  - Overview
  - Properties
    Properties
    
    Field
    
    Model
- ModelOnErrorEventParams
  ModelOnErrorEventParams
  - Overview
  - Properties
    Properties
    
    Model
- ModelOnValidateEventParams
  ModelOnValidateEventParams
  - Overview
  - Properties
    Properties
    
    Model
- ModelUndoRedoEventParams
  ModelUndoRedoEventParams
  - Overview
  - Properties
    Properties
    
    Models
- NavigatorOnHideEventParams
  NavigatorOnHideEventParams
  - Overview
  - Properties
    Properties
    
    Name
- NavigatorOnShowEventParams
  NavigatorOnShowEventParams
  - Overview
  - Properties
    Properties
    
    Name
- NavigatorSelectionChangedEventParams
  NavigatorSelectionChangedEventParams
  - Overview
  - Properties
    Properties
    
    Name
- PageAfterChangeEventParams
  PageAfterChangeEventParams
  - Overview
- PageBeforeChangeEventParams
  PageBeforeChangeEventParams
  - Overview
- ProjectAfterCloseEventParams
  ProjectAfterCloseEventParams
  - Overview
  - Properties
    Properties
    
    Filename
    
    Project
- ProjectAfterNewEventParams
  ProjectAfterNewEventParams
  - Overview
  - Properties
    Properties
    
    Project
- ProjectAfterOpenEventParams
  ProjectAfterOpenEventParams
  - Overview
  - Properties
    Properties
    
    Filename
    
    Project
- ProjectAfterReloadEventParams
  ProjectAfterReloadEventParams
  - Overview
  - Properties
    Properties
    
    Filename
    
    Project
- ProjectAfterSaveEventParams
  ProjectAfterSaveEventParams
  - Overview
  - Properties
    Properties
    
    Filename
    
    Project
- ProjectBeforeCloseEventParams
  ProjectBeforeCloseEventParams
  - Overview
  - Properties
    Properties
    
    Project
- ProjectBeforeOpenEventParams
  ProjectBeforeOpenEventParams
  - Overview
  - Properties
    Properties
    
    Filename
- ProjectBeforeReloadEventParams
  ProjectBeforeReloadEventParams
  - Overview
  - Properties
    Properties
    
    Filename
    
    Project
- ProjectBeforeSaveEventParams
  ProjectBeforeSaveEventParams
  - Overview
  - Properties
    Properties
    
    Filename
    
    Project

pre-save project event ¶

Description¶

This event is notified before saving the project.

API event argument type¶

ProjectBeforeSaveEventParams